OpenEdge Data Management:<br />DataServer for Microsoft SQL Server Configuring from the command line

You can configure a remote DataServer broker process from the command line. You can use the _probrkr.exe executable or use the mssman.bat Progress Explorer utility, the command line equivalent of using the Progress Explorer.

Before you start the configuration tasks, make sure that you have installed your ODBC software and any data source-specific client software on your host machine. Also make sure that you have registered all of your data sources. See the "Configuring an ODBC driver and registering the data source" section for details.

When using the OpenEdge broker (_probrkr.exe), you set the environment variables described in this section from the command line using environment-variable commands at the DOS shell prompt.

When using the mssman.bat Progress Explorer utility, set the environment variables described in this section in the environment section of your broker properties file for the specific broker instance definition.

You must set your environment variables in the same environment (DOS shell) from which you plan to run the DataServer.

Table 5–2: Environment variables for the remote DataServer
Variable	Description
`DSLOGDIR`(Optional)	The pathname of the log file that OpenEdge uses to keep track of DataServer processes and error messages. By default, OpenEdge writes to `%DSLOGDIR%\dataserv.lg` where `%DSLOGDIR%` is resolved to directory path of the log file `dataserv.lg`.
`MSSSRV`	The pathname of the OpenEdge server executable. This variable is required only when the DataServer is spawned using the OpenEdge broker (`_probrkr.exe`). When using mssman, this setting is satisfied by the `srvrExecFile` setting in the broker properties file.
`PROBRKR`(Optional)	The pathname of the broker executable. When using the OpenEdge broker (`_probrkr.exe`), set this variable on the host machine to the broker executable name. When using `mssman.bat`, this setting is satisfied by the broker instance definition in the broker properties file.
`PROSTARTUP`	The pathname of your default OpenEdge startup (.pf) file. To set the Message Buffer Size (`-Mm`) startup parameter for the broker to a value different from the 1024 default buffer size, you must set the `PROSTARTUP` environment variable equal to the path and name of the `.pf` file that contains the -Mm parameter. This approach ensures that your value is recognized and therefore used by the broker when it starts. Only Windows clients must use this technique. Note: If you use the command line utility and intend to set the `-Mm` startup parameter to a value other than 1024, you must use the `.pf` file with the `PROSTARTUP` variable set.

Once you have completely set up your environment, you can build the schema holder for your MS SQL Server database and connect using the client executable. See the "Creating a schema holder" section for instructions.

The ubroker.properties file

When using the Progress Explorer administration framework, you configure the DataServer for MS SQL Server by editing the %DLC%\properties\ubroker.properties file. This file stores configuration definitions for all instances of the following OpenEdge products:

When you use this file to configure the DataServer for MS SQL Server, you provide information that enables the host to start a broker that spawns the appropriate DataServer process (_msssrv.exe).

Each configuration definition contains the environment variable and property settings for a broker instance. The command-line utilities use this file to store, validate, and manage the configurations for these brokers. A single copy of this file maintains all supported broker configurations for each OpenEdge installation.

Editing the ubroker.properties file

The simplest way to make configuration changes to the ubroker.properties file is to copy an existing broker or NameServer definition and then modify the copied values as required for your configuration. You must ensure that all related properties and sections of the file are properly specified for each broker or NameServer instance.

Table 5–3 describes the sections in the ubroker.properties file that apply to the DataServer for MS SQL Server. The file configures a default NameServer named NameServer.NS1 and a default broker named mssbroker1, which you can use either without editing or as templates for your own configuration specifications.

Table 5–3: DataServer for MS SQL Server sections of the ubroker.properties file
Product	Section	Description
All products	ParentGroup	Defines the name of each NameServer and product broker parent entity.
	Environment	Default environment variable settings for all NameServers and product brokers.
	UBroker	Defines default property settings for all product brokers.
NameServer	NameServer	The parent entity of NameServers. It defines default property settings for all NameServer instances.
	NameServer.NS1	A sample property entity of a NameServer instance. It defines property settings for this NameServer instance.
	Environment.NS1	A sample environment entity of a NameServer instance. It defines environment variable settings for this NameServer instance.
DataServer	UBroker.MS	The parent entity of DataServer for MS SQL Server brokers. It defines default property settings for all of these broker instances.
DataServer	UBroker.MS.mssbroker1	A sample property entity of a DataServer for MS SQL Server broker instance. It defines default property settings for the broker instance named `mssbroker1`. Note that although many of the settings in this section can work in your environment, some of them are for demonstration purposes only. You must specify the appropriate settings for the following: `srvrExecFile`: Specify the pathname of the DataServer executable that the broker runs. @{Startup\DLC}\bin\_msssrv.exe, the default, which runs the default DataServer from your OpenEdge install path. `srvrStartupParam`: Specify the OpenEdge startup parameters for the DataServer. Do not modify the default parameters, although you can add parameters if necessary. The -svub switch is required for a broker connection in the Progress Explorer administration framework.
DataServer	Environment.mssbroker1	A sample environment entity of a DataServer for MS SQL Server broker instance. It defines environment variable settings that apply to the broker instance named `mssbroker1`. Be sure to set the variables to the appropriate values; the values in the file are for demonstration purposes only. Add to this section any environment variables that you want to apply to the DataServer’s environment. See the "Configuring a remote DataServer" section for the environment variable settings required to configure the DataServer for MS SQL Server.

The following example illustrates the DataServer sections of the ubroker.properties file:

# # Default properties for broker instances serving MSS DataServers # [UBroker.MS] srvrExecFile="@{Startup\DLC}\bin\_msssrv.exe" srvrStartupParam=-svub -S X -N TCP -U X -P X -hs 0 -s 40 operatingMode=State-aware classMain=com.progress.ubroker.broker.ubroker portNumber=4446 defaultService=0 initialSrvrInstance=0 minSrvrInstance=0 maxSrvrInstance=256 brkrLoggingLevel=3 description=MSS DataServer Broker # # Sample MSS DataServer Broker definition # [UBroker.MS.mssbroker1] srvrExecFile="@{Startup\DLC}\bin\_msssrv.exe" srvrStartupParam=-svub -S X -N TCP -U X -P X -hs 0 -s 40 srvrLogFile=@{WorkPath}\mssbroker1.server.log brokerLogFile=@{WorkPath}\mssbroker1.broker.log portNumber=4446 defaultService=1 appserviceNameList=mssbroker1 controllingNameServer=NS1 environment=mssbroker1 uuid=172.18.103.53:32:e031b1e7bc:-7d29 description=A sample MSS DataServer Broker # # Environment for MSS Dataserver Broker: mssbroker1 # [Environment.mssbroker1] DSLOGDIR=@{WorkPath}

 # 
 #  Default properties for broker instances serving MSS DataServers 
 # 
 [UBroker.MS] 
     srvrExecFile="@{Startup\DLC}\bin\_msssrv.exe" 
     srvrStartupParam=-svub -S X -N TCP -U X -P X -hs 0 -s 40  
     operatingMode=State-aware 
     classMain=com.progress.ubroker.broker.ubroker 
     portNumber=4446 
     defaultService=0 
     initialSrvrInstance=0 
     minSrvrInstance=0 
     maxSrvrInstance=256 
     brkrLoggingLevel=3 
     description=MSS DataServer Broker 
 # 
 # Sample MSS DataServer Broker definition 
 # 
 [UBroker.MS.mssbroker1] 
      srvrExecFile="@{Startup\DLC}\bin\_msssrv.exe" 
      srvrStartupParam=-svub -S X -N TCP -U X -P X -hs 0 -s 40  
      srvrLogFile=@{WorkPath}\mssbroker1.server.log 
      brokerLogFile=@{WorkPath}\mssbroker1.broker.log 
      portNumber=4446 
      defaultService=1 
      appserviceNameList=mssbroker1 
      controllingNameServer=NS1 
      environment=mssbroker1 
      uuid=172.18.103.53:32:e031b1e7bc:-7d29 
      description=A sample MSS DataServer Broker 
 # 
 # Environment for MSS Dataserver Broker: mssbroker1 
 # 
 [Environment.mssbroker1] 
      DSLOGDIR=@{WorkPath}

For a complete description of the parameters included in each of these sections, see the comments in the %DLC%\properties\ubroker.properties.README file.

The ubroker.properties file is read on startup of the AdminService process. For changes in any used environment variables to take effect, the AdminService must be restarted.

Validating ubroker.properties content

Whenever you create your own version of the ubroker.properties file, you should use the relevant validation utility to validate your changes and make sure that there are no syntax errors or conflicts. When configuring the DataServer for MS SQL Server, you validate the file by using the mssconfig.bat utility. For more information about the MSSCONFIG utility, see the Appendix B "Server Related Command Line Utilities and Startup Parameters."

Configuring multiple brokers

You can configure multiple brokers by adding more UBroker.MS.broker–name and Environment.broker–name sections. Each broker instance must have a unique name. The broker instances inherit the properties that you define in the UBroker.MS (parent entity) section, but can override them.

If you want to access multiple MS SQL Server databases and configure one or more brokers, each broker must run in a separate directory and a distinct environment.

Using the NameServer

By default, your DataServer for MS SQL Server broker instances are defined with a controlling NameServer and are provided with a default Data Service. Progress Software Corporation recommends using a NameServer configuration at all times. In such cases, the DataServer client’s initial connection is to the NameServer. However, you can alternatively connect the DataServer directly to the broker instance by setting the -DataService value to none in the connection parameters of your schema holder. If you will always use a -DataService value of none, you should remove the controlling NameServer from your broker instance definition. See the "Starting and stopping a broker process from the Progress Explorer and connecting a client" section for more information about connecting the DataServer to the NameServer and the broker. See OpenEdge Getting Started: Installation and Configuration for more information about the NameServer’s role in a configuration.